//
// DotNetNuke - http://www.dotnetnuke.com
// Copyright (c) 2002-2010
// by Perpetual Motion Interactive Systems Inc. ( http://www.perpetualmotion.ca )
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions 
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.
//

using System;
using System.Collections.Generic;
namespace DotNetNuke.Services.ModuleCache
{
	public abstract class ModuleCachingProvider
	{
		public static Dictionary<string, ModuleCachingProvider> GetProviderList()
		{
			return ComponentModel.ComponentFactory.GetComponents<ModuleCachingProvider>();
		}
		public static ModuleCachingProvider Instance(string FriendlyName)
		{
			return DotNetNuke.ComponentModel.ComponentFactory.GetComponent<ModuleCachingProvider>(FriendlyName);
		}
		public static void RemoveItemFromAllProviders(int tabModuleId)
		{
			foreach (KeyValuePair<string, ModuleCachingProvider> kvp in GetProviderList()) {
				kvp.Value.Remove(tabModuleId);
			}
		}
		protected string ByteArrayToString(byte[] arrInput)
		{
			int i;
			System.Text.StringBuilder sOutput = new System.Text.StringBuilder(arrInput.Length);
			for (i = 0; i <= arrInput.Length - 1; i++) {
				sOutput.Append(arrInput[i].ToString("X2"));
			}
			return sOutput.ToString();
        }

        #region Abstract methods
        public abstract string GenerateCacheKey(int tabModuleId, SortedDictionary<string, string> varyBy);
		public abstract int GetItemCount(int tabModuleId);
		public abstract byte[] GetModule(int tabModuleId, string cacheKey);
		public abstract void Remove(int tabModuleId);
		public abstract void SetModule(int tabModuleId, string cacheKey, TimeSpan duration, byte[] moduleOutput);
        #endregion

        #region "Virtual Methods"

        public virtual void PurgeCache(int portalId)
        {
        }

        public virtual void PurgeExpiredItems(int portalId)
        {
        }

        #endregion

        #region "Obsolete Methods"

        [Obsolete("This method was deprecated in 5.2.1")]
        public virtual void PurgeCache()
        {
        }

        [Obsolete("This method was deprecated in 5.2.1")]
        public virtual void PurgeExpiredItems()
        {
        }

        #endregion

    }
}
